/*
 * Copyright (c) 2013, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-expresso nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.grinder.library.equality.cardinality.direct.core;

import java.util.ArrayList;
import java.util.List;

import com.sri.ai.expresso.api.Expression;
import com.sri.ai.grinder.api.RewriterTest;
import com.sri.ai.grinder.api.RewritingProcess;
import com.sri.ai.grinder.core.AbstractRewriter;
import com.sri.ai.grinder.core.HasFormula;
import com.sri.ai.grinder.core.HasKind;
import com.sri.ai.grinder.core.HasNumberOfArguments;
import com.sri.ai.grinder.core.KindAttribute;
import com.sri.ai.grinder.library.FunctorConstants;
import com.sri.ai.grinder.library.equality.cardinality.direct.CardinalityRewriter;

/**
 * A wrapper around {@link QuantifierElimination} for expressions of a particular kind
 * (as defined by {@link KindAttribute}).
 * Creating wrappers for specific kinds allows applications of multiple rewriters to be optimized.
 * 
 * Note: This wrapper is required as the default implementation throws an
 * assertion exception if the input arguments are not what is expected.
 * 
 * @author oreilly
 */
public class QuantifierEliminationWrapper extends AbstractRewriter {	
	
	public QuantifierEliminationWrapper(Object kindValue) {		
		// Set the name based on the quantifier this is specific to.
		this.setName("Quantifier Elimination Wrapper for " + kindValue + " expressions");
		
		// Set up the relevant reified tests
		List<RewriterTest> reifiedTests = new ArrayList<RewriterTest>();
		reifiedTests.add(new HasKind(kindValue));
		if (kindValue.equals(FunctorConstants.NOT)) {
			reifiedTests.add(new HasNumberOfArguments(1));
		}
		else if (kindValue.equals(FunctorConstants.IMPLICATION) ||
				 kindValue.equals(FunctorConstants.EQUIVALENCE)) {
			reifiedTests.add(new HasNumberOfArguments(2));
		}
		reifiedTests.add(new HasFormula());
		
		this.setReifiedTests(reifiedTests.toArray(new RewriterTest[reifiedTests.size()]));
	}
	
	@Override
	public Expression rewriteAfterBookkeeping(Expression expression, RewritingProcess process) {
		Expression result = expression;

		result = process.rewrite(CardinalityRewriter.R_quantifier_elimination, expression);
		if (result.equals(expression)) {
			result = expression;
		}
		
		return result;
	}	
}